Importing Users

There are two techniques for accelerated addition of users into the system.

  • The first is "provisioning" - which will auto sync the Pyramid user list with groups in Active Directory. As such, this is only available with AD authentication.
  • The second involves uploading a list of users and their details with a static CSV formatted file - described below.
    • The "DB" template is for uploading users in a database authentication based system.
    • The "AD" template is for uploading users in an Active Directory authentication based system.

Note: Roles can also be uploaded into the system.

Important: Your spreadsheet must include all columns described below. Where a column is described as "optional," the column may be left empty but it needs to be present.

Accessing the Users page

  • Click here to access the Users page in the Admin Console

DB Upload File Format

The database file needs to be in comma delimited format, with the following columns:

  • username: the user's Pyramid username; the user ID for login ID's should contain only standard alpha numeric characters and no spaces.
  • License Type: specify the license type, 90 for Basic, 100 for Viewer, 150 for Analyst, and 200 for Professional. For more information, see Pyramid Licensing.
  • Admin Level: 0 for no admin, 1 for domain admin, 2 for enterprise admin. For more information, see Domain Admin Rights.
  • Tenant: use the tenant name as it appears in the system.
  • Roles: use the role name as it appears in the system. Multiple roles can be added using a semi-colon separator.
  • First Name: first name of user.
  • Last Name: last name of user.
  • Email: email address of user.
  • Password: initial password for the user.
  • UPN: Active Directory user name (optional, relevant when needing to connect to AD based data sources).
  • Profile: the user's profile (optional). Write one profile (by profile name) per user. The Profile must be compatible with the tenant.
  • Proxy Account 1: the field is used to inject an alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Proxy Account 2: the field is used to inject an alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Language: the user's default application language. The LanguageType is defined as a number in Pyramid. For example, the value "2" in this column indicates that the user represented by the row has the application language French. For more information about the Language Type enumeration, see LanguageType.

The first row in the file is treated as a header row.

Template CSV

You can download an empty spreadsheet (*.csv) for your own bulk loading process: Example Add Users DB.

AD Upload File Format

The active directory file needs to be in comma delimited format, with the following columns:

  • domain\Username: AD account name in the format "domain\username". Ensure the domain is added to the system in the authentication settings.
  • License Type: specify the license type, 90 for Basic, 100 for Viewer, 150 for Analyst, and 200 for Professional. For more information, see Pyramid Licensing.
  • Admin Level: 0 for no admin, 1 for domain admin, 2 for enterprise admin. For more information, see Domain Admin Rights.
  • Tenant: use the tenant name as it appears in the system.
  • Roles: use the role name as it appears in the system. Multiple roles can be added using a semi-colon separator.
  • Profile: the user's profile (optional). Write one profile (by profile name) per user. The Profile must be compatible with the tenant.
  • Proxy Account 1: the field is used to inject an alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Proxy Account 2: the field is used to inject an alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Language: the user's default application language. The LanguageType is defined as a number in Pyramid. For example, the value "2" in this column indicates that the user represented by the row has the application language French. For more information about the Language Type enumeration, see LanguageType.

The first row in the file is treated as a header row.

Template CSV

You can download an empty spreadsheet (*.csv) for your own bulk loading process: Example Add Users AD.

SAML Upload File Format

The following format is used to upload SAML users via a CSV file:

  • Username: the user's Pyramid username.
  • License Type: specify the license type, 90 for Basic, 100 for Viewer, 150 for Analyst, and 200 for Professional. For more information, see Pyramid Licensing.
  • Admin Level: 0 for no admin, 1 for domain admin, 2 for enterprise admin. For more information, see Domain Admin Rights.
  • Tenant: use the tenant name as it appears in the Pyramid system.
  • Roles: use the role name as it appears in the system. Multiple roles can be added using a semi-colon separator.
  • First Name: first name of user.
  • Last Name: last name of user.
  • Email: email address of user.
  • Password: initial password for the user.
  • UPN: the user's SAML username.
  • Profile: the user's Pyramid profile (optional). Write one profile (by profile name) per user. The Profile must be compatible with the tenant.
  • Proxy Account 1: the field is used to inject an alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Proxy Account 2: the field is used to inject an alternative account name to be used with alternative system authentications. For example, the user's Active Directory account needed for Microsoft SSAS authentication, or the user's SAP BW login for onward connection in other single sign-on environments (for example, Azure or Snowflake). Optional.
  • Language: the user's default application language. The LanguageType is defined as a number in Pyramid. For example, the value "2" in this column indicates that the user represented by the row has the application language French. For more information about the Language Type enumeration, see LanguageType.

The first row in the file is treated as a header row.

Template CSV

You can download an empty spreadsheet (*.csv) for your own bulk loading process: Example Add Users SAML.